Inside Macintosh: QuickTime /

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Functions That Modify Movie Properties / Working With Movie User Data

GetMovieUserData

The GetMovieUserData function allows your application to obtain access to a movie's user data list. You can then use the GetUserData, AddUserData, and RemoveUserData functions (described on page 2-219, page 2-219, and page 2-220, respectively) to manipulate the contents of the user data list. If the data list contains text data, you can use the GetUserDataText, AddUserDataText, and RemoveUserDataText functions (described on page 2-221, page 2-220, and page 2-222, respectively) to work with its contents.

pascal UserData GetMovieUserData (Movie theMovie);

theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle (described on page 2-80, page 2-76, and page 2-78, respectively).

DESCRIPTION

The GetMovieUserData function returns a reference to the movie's user data list. This reference is valid until you dispose of the movie. When you save the movie, the Movie Toolbox saves the user data as well. If the function could not locate the movie's user data, it sets this returned value to nil.

ERROR CODES

invalidMovie

-2010

This movie is corrupted or invalid

Memory Manager errors

SEE ALSO

You can use the GetMediaUserData function (described on page 2-217) to gain access to a media's user data. Similarly, you can use the GetTrackUserData function (described in the next section) to work with a track's user data.